Package com.cisco.pt.ipc.sim
Interface DeviceDescriptor
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
DeviceDescriptorImpl
Information provided by the PKI file:
\class DeviceDescriptor
\brief Descriptor for a device.
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionvoidInformation provided by the PKI file:voidaddSpecifiedModel(String model) Information provided by the PKI file:voidInformation provided by the PKI file:getModel()Information provided by the PKI file:getRequiredScriptModuleAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getSpecifiedModelAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:getSupportedModuleTypeAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:getType()Information provided by the PKI file:booleanisExistSpecifiedModel(String model) Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:voidInformation provided by the PKI file:voidremoveSpecifiedModel(String model) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetModelSupportedFlag(boolean isSupported) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
getType
DeviceType getType()Information provided by the PKI file:
\brief Return device type \return DeviceType start with 0 and add 1 for subsequent type eRouter = 0, eSwitch, eCloud, eBridge, eHub, eRepeater, eCoAxialSplitter, eAccessPoint, ePc, eServer, ePrinter, eWirelessRouter, eIpPhone, eDslModem, eCableModem, eRemoteNetwork, eMultiLayerSwitch, eLaptop, eTabletPC, ePda, eWirelessEndDevice, eWiredEndDevice, eTV, eHomeVoip, eAnalogPhone, eMultiUser, eASA, eIoE, eHomeGateway, eCellTower, eCentralOfficeServer, eCiscoAccessPoint, eEmbeddedCiscoAccessPoint, eSniffer, eMCU, eSBC, eThing, eMCUComponent, eEmbeddedServer, eWirelessLanController, eCluster, eGeoIcon- Returns:
- DeviceType Returns a DeviceType
-
getModel
String getModel()Information provided by the PKI file:
\brief Get device model \return string, device model in string format- Returns:
- String Returns a String
-
addSupportedModuleType
Information provided by the PKI file:
\brief Add supported module type to device descriptor \param type, module type ModuleType, start with 0 and add 1 to subsequent module type eLineCard=0, eNetworkModule, eInterfaceCard, ePtRouterModule, ePtSwitchModule, ePtCloudModule, ePtRepeaterModule, ePtHostModule, ePtModemModule, ePtLaptopModule, ePtTVModule, eIpPhonePowerAdapter, ePtTabletPCModule, ePtPdaModule, ePtWirelessEndDeviceModule, ePtWiredEndDeviceModule, eTrs35, eUsb, eNonRemovableModule, eASAModule, eASAPowerAdapter, ePtCellTowerModule, ePtIoeModule, ePtIoeNetworkModule, ePtIoeAnalogModule, ePtIoeDigitalModule, ePtIoeCustomIOModule, ePtIoePowerAdapter, ePtIoeMcuComponentPowerAdapter, ePtRouterPowerAdapter, eSfpModule, eAccessPointPowerAdaptor, eNonRemovableInterfaceCard, eCustomModuleType = 2000- Parameters:
type- Takes in a parameter of type
-
removeSupportedModuleType
Information provided by the PKI file:
\brief Remove supported module type to device descriptor \param type, module type ModuleType, same type as param for addSupportedModuleType().- Parameters:
type- Takes in a parameter of type
-
isModuleTypeSupported
Information provided by the PKI file:
\brief Check if module type is supported \param type, ModuleType \param type, module type ModuleType, start with 0 and add 1 to subsequent module type eLineCard=0, eNetworkModule, eInterfaceCard, ePtRouterModule, ePtSwitchModule, ePtCloudModule, ePtRepeaterModule, ePtHostModule, ePtModemModule, ePtLaptopModule, ePtTVModule, eIpPhonePowerAdapter, ePtTabletPCModule, ePtPdaModule, ePtWirelessEndDeviceModule, ePtWiredEndDeviceModule, eTrs35, eUsb, eNonRemovableModule, eASAModule, eASAPowerAdapter, ePtCellTowerModule, ePtIoeModule, ePtIoeNetworkModule, ePtIoeAnalogModule, ePtIoeDigitalModule, ePtIoeCustomIOModule, ePtIoePowerAdapter, ePtIoeMcuComponentPowerAdapter, ePtRouterPowerAdapter, eSfpModule, eAccessPointPowerAdaptor, eNonRemovableInterfaceCard, eCustomModuleType = 2000 \return bool, true if the module type is supported and false if not- Parameters:
type- Takes in a parameter of type- Returns:
- boolean Returns a boolean
-
getSupportedModuleTypeCount
int getSupportedModuleTypeCount()Information provided by the PKI file:
\brief Get the number of module type \return int, number of module type- Returns:
- int Returns a int
-
getSupportedModuleTypeAt
Information provided by the PKI file:
\brief Get the supported module type at a specified index \param index, the specified index \return ModuleType, see different types documented in addSupportedModuleType() function- Parameters:
index- Takes in a parameter of index- Returns:
- ModuleType Returns a ModuleType
-
getRootModule
ModuleDescriptor getRootModule()Information provided by the PKI file:
\brief Get the root module descriptor \return ModuleDescriptor, root module descriptor- Returns:
- ModuleDescriptor Returns a ModuleDescriptor
-
isModelSupported
boolean isModelSupported()Information provided by the PKI file:
\brief Check if the descriptor is model supported \return bool, true if model supported and false if not- Returns:
- boolean Returns a boolean
-
getSpecifiedModelCount
int getSpecifiedModelCount()Information provided by the PKI file:
\brief Get specified model count \return int, the number of specified model- Returns:
- int Returns a int
-
getSpecifiedModelAt
Information provided by the PKI file:
\brief Get specified model at a specified index \param index, specified index \return string, the specified model name in string format- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
isExistSpecifiedModel
Information provided by the PKI file:
\brief Check if the model exist \param model, specified model \return bool, true if the model exist and false if it does not- Parameters:
model- Takes in a parameter of model- Returns:
- boolean Returns a boolean
-
addSpecifiedModel
Information provided by the PKI file:
\brief Add module model to support \param model, specified model- Parameters:
model- Takes in a parameter of model
-
removeSpecifiedModel
Information provided by the PKI file:
\brief Remove model model to support \param model, specified model- Parameters:
model- Takes in a parameter of model
-
setModelSupportedFlag
void setModelSupportedFlag(boolean isSupported) Information provided by the PKI file:
\brief Set supported flag to the device descriptor \param isSupported, true if supported and false if not \return none- Parameters:
isSupported- Takes in a parameter of isSupported
-
addRequiredScriptModule
Information provided by the PKI file:
\brief Add required script module \param smId, script module id \return none- Parameters:
smId- Takes in a parameter of smId
-
removeRequiredScriptModule
Information provided by the PKI file:
\brief Removed required script module \param smId, script module id \return none- Parameters:
smId- Takes in a parameter of smId
-
getRequiredScriptModuleCount
int getRequiredScriptModuleCount()Information provided by the PKI file:
\brief Get the number of required script module \return int, number of required script module- Returns:
- int Returns a int
-
getRequiredScriptModuleAt
Information provided by the PKI file:
\brief Get the name of the required script module at a specified index \param index, specified index \return string, script module name- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-